core/androidx.core.app/[main]ServiceCompat

ServiceCompat

class ServiceCompat(source)

Helper for accessing features in android.app.Service.

Types

StopForegroundFlags

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

@Retention(value = RetentionPolicy.SOURCE)

annotation class StopForegroundFlags

Properties

START_STICKY

val START_STICKY: Int = 1

Constant to return from onStartCommand: if this service's process is killed while it is started (after returning from onStartCommand), then leave it in the started state but don't retain this delivered intent.

STOP_FOREGROUND_DETACH

val STOP_FOREGROUND_DETACH: Int = 2

Flag for stopForeground: if set, the notification previously provided to startForeground will be detached from the service.

STOP_FOREGROUND_REMOVE

val STOP_FOREGROUND_REMOVE: Int = 1

Flag for stopForeground: if set, the notification previously provided to startForeground will be removed.

Functions

startForeground

open fun startForeground(@NonNull service: @NonNull Service, id: Int, @NonNull notification: @NonNull Notification, foregroundServiceType: Int)

startForeground with the third parameter foregroundServiceType was added in Q.

stopForeground

open fun stopForeground(@NonNull service: @NonNull Service, flags: Int)

Remove the passed service from foreground state, allowing it to be killed if more memory is needed.